16891 views

 

27% MelonadeM

::|CONTENTS

1. Firki Syntax
2. Firki on BotB
3. Link Tokens
4. Text Style Tokens
5. Text Style Tokens Examples
6. Block Tokens
7. List Tokens
8. Meta Tokens
9. Firki BotB futures

日本語はこちらです。

Firki is an experimental lightweight markup language

which loosely resembles syntactical concepts found in both BBCode

and WikiText

. With the help of Firki the firteen writing staff could format their own articles' sense of look and style while only learning one cryptically simple markup language instead of the confusing fusion of both HTML and CSS.

Firki Syntax

---

There are three basic marks which are used to build a Firki token. So long as the token is formated properly Firki can translate the token into browser-understandable HTML*CSS. It should be known that Firki has very little to no error handling! :D

Teh 3 Firki Marks

'[ => opening tick mark/symbol
followed by an action identifier (aka param0)

[ => parameter separator mark/symbol
followed by the next parameter for the action

] => closing delimiter mark/symbol
ends the token

So in example --
'[param0[param1[param2[param3[...etc...[paramX]

"param0" is the action identifier for the Firki token. The following parameters are extensions or commands of said action identifier. The amount of parameters to pass in a token depends on what the action is looking for.

Some actions may have optional parameters. In the case that default settings are desired for an optional parameter then the parameter space should be empty (no spaces, nothing) between the token marks.

example
'[l[http://n00b.com] => http://n00b.com

Firki on BotB

---

BotB's Lyceum uses an optimized (or, rather a stripped-down) version of the Firki markup language originally created for a CMS craptank style blog-o-sphere. It is used in place of HTML due to HTML's hackable nature. And BotB can not afford to trust no one (double negative there =X what does it mean?!?!!?)!

Link Tokens

---

URL Link

'[l[URL[linktext]
or
'[l[URL]
'[l[[URL]

example
'[l[http://n00b.com[n00b] => n00b

'[l[http://n00b.com]

=> http://n00b.com

Link to Lyceum Article

'[[Article_Title]
The hyperlink will be in red if the article does not yet exist.

example
'[[n00b] => n00b

An additional parameter masks the article title's text.
example
'[[botbr[BotBrs] => BotBrs

Chapters are available as anchor links, which may be linked to using the # sign.
example
'[[Firki Markup#Link Tokens[Link Tokens] => Link Tokens

Text Style Tokens

---

override opening tick
'[']
displayed as '[

bold
'[b]bold'[/b]

code,
'[c]

code


code

'[/c]
it displays tabs (Thank you, LittleTheremin, for sharing about!)

oblique / italic
'[o]oblique / italic'[/o]

strike
'[-s]strike'[/-s]

subscript
'[_s]_subscript'[/_s]

underline
'[u]underline'[/u]

Start Text Class Span
'[t[(text class)]

End Text Class Span
'[/t]

Available Text Classes : 0, 1, 2, 3, 4, b0, b1, b2, b3, b4, mono

NOTE :: BotB text default == Text Style '1'.
(text style '1' is slightly larger than the default one)

The [code] text class has been deprecated. The [c] markup always creates line skips somewhere and can no longer be used within a paragraph.

example
'[t[b0]n00b'[/t] => n00b

Text Style Tokens Examples

---

examples with This is a text, have a nice day :) (Note that some are hard to read in some palettes, be sure that if you use them in your bio; they are readable with your palette!)

This is a text, have a nice day :)
'[t[t monofont]This is a text, have a nice day :)'[/t]

This is a text, have a nice day :)
'[t[mono]This is a text, have a nice day :)'[/t]

This is a text, have a nice day :)

'[c]This is a text, have a nice day :)'[/c]

This is a text, have a nice day :)
'[t[t searchInput]This is a text, have a nice day :)'[/t]

This is a text, have a nice day :)
'[t[t list]This is a text, have a nice day :)'[/t]

This is a text, have a nice day :)
'[t[t boxLink]This is a text, have a nice day :)'[/t]

This is a text, have a nice day :) though unfortunately, this doesn't display on the lyceum
'[t[t tableTop]This is a text, have a nice day :) though unfortunately, this doesn't display on the lyceum'[/t]

This is a text, have a nice day :)





'[t[t grid_1]This is a text, have a nice day :)'[/t]

This is an invisible text; it isn't a joke lol, have a nice day :)
'[t[t clear]This is an invisible text; it isn't a joke lol, have a nice day :)'[/t]

This is a text, have a nice tab :)
'[t[t tab]This is a text, have a nice tab :)'[/t]

This is a text, have a nice day :) BUT what if i type more than is supposed to? idk what i'm expecting AAAAAAAAAAAAAAAAAAAAAAAAAAA
'[t[t tMedals]This is a text, have a nice day :) (...)'[t]

This is a text, have a nice day :)
And some nice borders
and why not a tab too? :D
though this doesn't display on the lyceum
'[t[t tablecontent]This is a text, have a nice day :)
And some nice borders
'[t[t tab]and why not a tab too? :D
though this doesn't display on the lyceum'[/t]'[/t]

This is a text, have a nice day :) hi :D
'[t[t tb4]This is a text, have a nice day :) hi :D'[/t]

battle of the bits
'[t[t logo]battle of the bits'[/t]

yes this is all lower-case
'[t[t fakecaps]yes this is all lower-case'[/t]

line 1line 2
'[t[t hSeperator]line 1'[/t]line 2

battle of the bitsbattle of the bitsbattle of the bits
'[t[t hMiniSeperator]battle of the bits'[/t]'[t[t hMiniSeperator]battle of the bits'[/t]'[t[t hMiniSeperator]battle of the bits'[/t]

Shadowed text!
'[t[t gssb_e]Shadowed text!'[/t]

Another font? o_o
'[t[t gssb_h]Another font? o_o'[/t]

Secret!
'[t[t gssb_i]Secret!'[/t]

Another Secret! =o
'[t[t gssb_l]Another Secret! =o'[/t]

Black text in white backgrond
'[t[t gssb_m]Black text in white backgrond'[/t]

WHAT IS THIS?~ (Doesn't show up in the lyceum)
'[t[t left]WHAT IS THIS?~ (Doesn't show up in the lyceum)'[/t]

IS THIS A WIP IN-SITE CHAT ENGINE? (Doesn't show up in the lyceum either)
'[t[t right]IS THIS A WIP IN-SITE CHAT ENGINE? (Doesn't show up in the lyceum either)'[/t]

this adds a little tab (Shows no effect on the lyceum)
'[t[t text]this adds a little tab(Shows no effect on the lyceum)''[/t]

this pads 5 pixels to both sides
'[t[t shade pad5]this pads 5 pixels to both sides'[/t]

this is a what?
'[t[t lilBox]this is a what?'[/t]

I'm big and at the left o_O

'[t[t hButt]I'm big and at the left o_O'[/t]

I'm big and at the right O_o (though the alignment doesn't work on the lyceum)
'[t[t vButt]I'm big and at the right O_o (though the alignment doesn't work on the lyceum)'[/t]

this is a monospaced font wow
'[t[t tmono]this is a monospaced font wow'[/t]

Oh my, this looks cool!
'[t[t CSVtags]Oh my, this looks cool!'[/t]

A merchant crosses your path -
"I've got nothing, I tell ya."
'[t[t uiWindow]'[i[disk/npc/merchant2.gif] A merchant crosses your path -
"I've got nothing, I tell ya."'[/t]

Bold black test in a white background
'[t[t list]Bold black test in a white background'[/t]

Big top and bottom padding (Doesn't show on lyceum)
'[t[t attachment]Big top and bottom padding (Doesn't show on lyceum)'[/t]

This makes a block of text (Unfortunately, not on lyceum)
'[t[t suffix_4]This makes a block of text (Unfortunately, not on lyceum)'[/t]

This adds your palette's background color to text (though as you can see, doesn't take effect on the lyceum)
'[t[t tableBottom]This adds your palette's background color to text (though as you can see, doesn't take effect on the lyceum)'[/t]

The next two ones were tricks first pioneered by Savestate, big props to him! \o/


hi

Avocados are the best fruit

don't you agree? = p



'[i[disk/avatars/08291_3boQCHPNskwiw.png[r]
hi

Avocados are the best fruit

don't you agree? = p
(See Block Tokens for more info)



Menu Title

Avocado is the bestViLXDRYAD¶ post 419

I love avocados and firki markup :)






'[t[t clearfix grid_5 inner]'[t[t t2]Menu Title'[/t]
'[t[t inner boxLink t1]'[icon[bulletins]'[t[t tb2 tab]Avocado is the best'[t[t t0 floatR]ViLXDRYAD'[t[t tiny]¶'[t[t t0] post 419'[/t]'[/t]'[/t]'[/t]

'[t[b1]I love avocados and firki markup :)'[/t]'[/t]'[/t]

Block Tokens

---

Insert Image
Please review uploading pics for general stuff on that.

'[i[image_id[(alignment)]

image_id => the number associated with the uploaded image
alignment => an optional parameter; working values are 'r', 'right', 'l', 'left'

example
'[i[10[r] =>

Inserting an external image
simply replace image_id with an url, but with the http: or https: part of the beginning chopped off ( https://image.yeaj/to/it would become //image.yeaj/to/it)


for example:
'[i[//i.imgur.com/ElvkNs9.png[l]





See also: Icons

Mark Chapter
If chapters are marked than a Table of Contents box will appear at the upper-left corner of the article which links to each chapter.

'[#[Chapter_Title]


Tabulator
Bounds text into a fixed width box. Default width is 80px.

'[tab[see]'[tab[this[120]'[tab[?]
'[tab[woah]'[tab[that's[60]'[tab[sweets[60]'[tab[!] =>

List Tokens

---

unordered list
'[ul[(list item tokens here)]

ordered list
'[ol[(list item tokens here)]

list item
'[li[text]

List items are embedded inside the list tag like so -
'[ul['[li[dingle]'[li[bar]] =>

• dingle
• bar

Meta Tokens

---

'['] => '[ (display firki markup opening tick for examples)
'[{] => [ (display opening bracket within firki markup)
'[}] => ] (display closing bracket within firki markup)

Firki BotB futures

---

More markups are coming. We shan't be specific until they are released in whenever patches.